docs: restructure to shadcn-style hierarchical IA#39
Open
abdout wants to merge 1 commit into
Open
Conversation
Move 35 flat MDX files into five subdirectories that mirror shadcn/ui's docs IA: installation/, engine/, engine/agents/, operations/, reference/, resources/. Strip the duplicate body H1 from each file — the page wrapper already renders the title from frontmatter, so the body heading was producing two H1s per page. Why: the previous flat layout made shadcn-style sectioning impossible and broke the visual hierarchy users expect from a modern docs site. Hierarchical folders let Fumadocs auto-derive nav from meta.json and unlock per-section page templates in later phases. - 7 new meta.json files declare per-folder page order - DOCS_NAV in docs-sidebar.tsx rewritten to 5 top-level sections plus Introduction; existing renderLink/SidebarGroup markup unchanged - 70 redirects (35 old slugs × 2 lang variants) keep old URLs working as 307 (temporary). Flip to 301 after 7 days of monitoring. - scripts/check-docs-links.mjs validates that every /docs/* link in MDX resolves to a real file; exposed as `pnpm docs:check` - 8 inline cross-links in installation/index.mdx updated to new paths to avoid 307 hops within the docs site itself Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
This was referenced May 18, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Mirrors shadcn/ui's hierarchical docs IA. 35 flat MDX files now live in 5 sections (
installation/,engine/,operations/,reference/,resources/), with per-foldermeta.jsonand a sidebar rewrite. Old URLs keep working via 70 temporary redirects.This is Phase 1 of 4. Phases 2-4 (page-template rewrites, new sections, polish) ship as follow-up PRs.
Changes
installation/,engine/,engine/agents/,operations/,reference/,resources/. Git tracks each as a rename at 97-100% similarity, full history preserved.meta.jsonper folder (7 new): drives Fumadocs nav order; replaces the old flat list with separator strings.DOCS_NAVinsrc/components/docs/docs-sidebar.tsxnow renders five sections (Getting Started / Engine / Operations / Reference / Resources) plus Introduction.next.config.ts: 35 old slugs × 2 lang variants (/docs/<old>and/:lang/docs/<old>). Usingpermanent: false(307). Flip to 301 after ~7 days of monitoring.scripts/check-docs-links.mjs+pnpm docs:check: validates every/docs/*link in MDX resolves to a real file. Currently passes 0/36.app/[lang]/(root)/docs/[[...slug]]/page.tsx:61already renders title from frontmatter; the body# Titleline removed from 34 files to eliminate double H1.installation/index.mdxso internal links go direct, not via 307 hop.Test plan
pnpm docs:checkcleannext buildsucceeds — 36 docs routes generated, all under new paths/en/docs/agents→/en/docs/engine/agents,/en/docs/onboarding→/en/docs/installationsite:kun.databayt.orgon Google, verify all indexed old URLs 307; if clean, flip redirects to 301Out of scope
generateStaticParamsstill hardcodes `lang: "en"` in `page.tsx:17` (parallel concern)🤖 Generated with Claude Code